/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.inlong.agent.store;

import java.io.Closeable;
import java.util.List;

/**
 * Store for task, instance and offset info
 */
public interface Store extends Closeable {

    KeyValueEntity get(String key);

    /**
     * store keyValue, if key has exists, overwrite it.
     *
     * @param entity key/value
     */
    void put(KeyValueEntity entity);

    /**
     * remove keyValue by key.
     *
     * @param key key
     * @return key/value
     * @throws NullPointerException key should not be null.
     */
    KeyValueEntity remove(String key);

    /**
     * find all by prefix key.
     *
     * @param prefix prefix string
     * @return list of k/v
     */
    List<KeyValueEntity> findAll(String prefix);

    String getSplitter();

    String getUniqueKey();

    String replaceKeywords(String source);
}
